Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Recipe #229: Behavior with Ranges #304

Open
wants to merge 31 commits into
base: master
Choose a base branch
from
Open

Conversation

kirschbombe
Copy link
Contributor

No description provided.

@kirschbombe kirschbombe self-assigned this Mar 9, 2022
@kirschbombe kirschbombe changed the title Behavior with Ranges (229) Recipe #229: Behavior with Ranges Mar 9, 2022
@glenrobson glenrobson linked an issue Sep 6, 2024 that may be closed by this pull request
@triplingual triplingual self-assigned this Sep 27, 2024
Copy link
Contributor

@markpbaggett markpbaggett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello, I listed a lot of thoughts as a review, but here is a condensed list of suggestions to help navigate the more specific thoughts:

  1. The title should reflect the purpose of the recipe. Maybe Adding Thumbnail Navigation to a Video Resource would be best?
  2. The point of the recipe seems to be about implementing thumbnail navigation. I don't think any of the viewers support that so I wouldn't list any currently.
  3. Move the initial paragraph in implementation notes to related recipes.
  4. I think implementation notes would be better if it followed from this recipe's implementation notes section more closely.
  5. I don't think we need metadata in the JSON to keep it more readable.
  6. I suggested a new label to the first visible range, but do we even need labels if the point is thumbnail-nav?

recipe/0229-behavior-ranges/index.md Outdated Show resolved Hide resolved
recipe/0229-behavior-ranges/index.md Outdated Show resolved Hide resolved
recipe/0229-behavior-ranges/manifest.json Outdated Show resolved Hide resolved
_includes/links.md Outdated Show resolved Hide resolved
index.md Outdated Show resolved Hide resolved
recipe/0229-behavior-ranges/index.md Outdated Show resolved Hide resolved
recipe/0229-behavior-ranges/index.md Outdated Show resolved Hide resolved
Comment on lines +26 to +28
One of the present ways to influence navigation behavior is to use the `no-nav` value, telling a client explicitly to not include a portion of the resource in navigation. When this value appears, whatever Canvases or portions of Canvases are used in the `items` part of the Range should not appear in the interface's navigation. The `id` of a Canvas in the `items` section indicates a Canvas from the Manifest's own `items` section or can be such an `id` with a bounding fragment for AV resources.

The other value used in this recipe is the `thumbnail-nav` value, which directs the consuming client to present an alternate, visual navigation structure using the thumbnail(s) with this `behavior` value. The API is quite clear that a traditional table of contents is not the place to put this visual navigation. Something more akin to thumbnail scrubbing is the metaphor to aim for. This can work with AV resources, where thumbnails might be put along a timeline to represent key moments a viewer might want to use in navigation. It can also be used with still images, where thumbnails might be employed usefully to navigate very large images (long, tall, or both dimensions). For those large still images, thumbnail based navigation — independent of the manifest's Canvases' thumbnails — may be arranged in any way that presents a helpful experience.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this section would be stronger if it followed the Implementation Notes section here:

https://iiif.io/api/cookbook/recipe/0024-book-4-toc/

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+2

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@markpbaggett Could you elaborate a bit? "Followed" as in conceptual order or "followed" as in "text differing only in what is different in this recipe" or as in something else?

recipe/0229-behavior-ranges/index.md Outdated Show resolved Hide resolved
recipe/0229-behavior-ranges/manifest.json Outdated Show resolved Hide resolved
@glenrobson
Copy link
Member

Patrick and I met to review the recipe and agree with Mark's comments.

  • We suggest maybe the title could be "Adding Thumbnail Navigation and noNav to a Video Resource" as the recipe shows noNav and thumbnail behaviours.

  • In the use case: could you mention the noNav use case and with the thumbnail behaviour focus on end users e.g. something like "As a user using a video I would like to have access to thumbnail scrubbing to quickly navigate a video".

  • We discussed leaving the label in the structure and rename it to “Thumbnail Navigation”

  • Remove restrictions section as there are none

  • Standardise the order of height and width within the manifest.

We thought it is OK to go to trc with our and Mark's changes integrated.

@triplingual
Copy link
Contributor

Also, ach, sorry @glenrobson about making the dimensions strings instead of ints. 🤦🏻‍♂️

@triplingual
Copy link
Contributor

  • Remove restrictions section as there are none

Noting that in the Cookbook authors' call we saw that the Cookbook is inconsistent on this matter. Mine have kept it in, so I left it in this one as well. An issue for the Cookbook editors to resolve whether removing it or leaving it is cognitively less of a load for the range of audiences the Cookbook is trying to reach.

@triplingual
Copy link
Contributor

  • Standardise the order of height and width within the manifest.

Done in 18c9f8a

@triplingual
Copy link
Contributor

  • In the use case: could you mention the noNav use case and with the thumbnail behaviour focus on end users e.g. something like "As a user using a video I would like to have access to thumbnail scrubbing to quickly navigate a video".

Though this is the conventional phrasing for software use cases, the Cookbook by and large uses a phrasing of "you want to [XYZ]" in the Use Case section, so I've rewritten the use case per @markpbaggett's ideas (with additional editing) but left it in the Cookbook's usual phrasing.

At first it didn't make sense to take out the 'Alternate' part because it is not supposed to render as a standard TOC. But I came around to agreeing because thumbnail navigation is inherently alternate
@triplingual
Copy link
Contributor

  • We discussed leaving the label in the structure and rename it to “Thumbnail Navigation”

Done in 2e84fc3

@triplingual
Copy link
Contributor

  • We suggest maybe the title could be "Adding Thumbnail Navigation and noNav to a Video Resource" as the recipe shows noNav and thumbnail behaviours.

Done in e753530

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta: ready-for-trc Issue is ready for TRC review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

behavior property with Ranges
4 participants